DescribeLoadBalancers
Description
call DescribeLoadBalancers to query the created load balancing instance.
Request Method
POST
Request Path
/apsara/route/Slb/DescribeLoadBalancers
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| Address | BODY | string | No | 192.168.0.1 | the service address of the load balancing instance. |
| VSwitchId | BODY | string | No | vsw-bp12mw1f8k3**** | the switch ID to which the load balancing instance belongs. |
| AddressIPVersion | BODY | string | No | ipv4 | IP version, can be set to ipv4 or ipv6. Description Currently, IPv6 instances are supported and the instance type must be guaranteed-performance instances. The available areas are as follows: e and f usable areas in east China 1 region, f and g usable areas in north China 2 region, d and e usable areas in east China 3 region, a and B usable areas in north China 3 region, and d and e usable areas in south China 1 region. |
| LoadBalancerId | BODY | string | No | lb-bp1b6c719dfa**** | load balancing instance ID. supports multi-value queries. You can enter up to 10 IDs separated by commas (,). |
| PayType | BODY | string | No | PayOnDemand | load balancing instance payment type. Value:PayOnDemand or PrePay. PayOnDemand: Pay by volume. PrePay: package year and month. |
| SlaveZoneId | BODY | string | No | cn-hangzhou-d | the standby zone ID of the load balancing instance. Currently, the multi-zone function is not supported for financial cloud users. |
| version | BODY | string | No | 2016-01-01 | version of api |
| InternetChargeType | BODY | string | No | paybybandwidth | public network instance payment method. Value:paybybandwidth or paybytraffic. paybybandwidth: Billing by bandwidth. paybytraffic: Billing by traffic. description if this parameter is not specified, it means that the original charging method is maintained. |
| LoadBalancerName | BODY | string | No | abc1 | load balancing instance name. supports multi-value queries. You can enter up to 10 names separated by commas (,). |
| ServerId | BODY | string | No | vm-23**** | added backend server ID. |
| VpcId | BODY | string | No | vpc-bp1aevy8sof**** | VPC ID to which the load balancing instance belongs. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| NetworkType | BODY | string | No | vpc | The network type of the private network load balancing instance. Valid values:vpc or classic. vpc: vpc instance. classic: classic network instance. |
| RegionId | BODY | string | Yes | cn-qingdao-env17-d01 | the region ID of the load balancing instance. you can query the region ID from the region and available area list or by calling the DescribeRegions interface. |
| AddressType | BODY | string | No | intranet | the network type of the load balancing instance. Value:intranet or internet. internet: after creating a public network load balancing instance, the system will assign a public network IP address to forward public network requests. intranet: after creating an intranet load balancing instance, the system will assign an intranet IP address and only forward intranet requests. |
| ServerIntranetAddress | BODY | string | No | 10.XX.XX.6 | the intranet address of the added backend server. supports multi-value queries separated by half-width commas (,). |
| MasterZoneId | BODY | string | No | cn-hangzhou-b | the primary zone ID of the load balancing instance. |
| Tags | BODY | string | No | {"tagKey":"Key1","tagValue":"Value1"} | the tag list of load balancing instance binding, its structure is a json dictionary, including TagKey and TagValue. In a request, the tag list supports up to 10 elements. |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| Address | string | 100.XX.XX.28 | server load balancing instance service address. |
| RequestId | string | 365F4154-92F6-4AE4-92F8-7FF34B540710 | request ID. |
| VSwitchId | string | vsw-255ecr**** | the switch ID of the private network load balancing instance. |
| CreateTime | string | 2017-08-31T02:49:05Z | load balancing instance creation time. |
| AddressIPVersion | string | ipv4 | IP version, which can be set to ipv4 or ipv6. |
| LoadBalancers | array of loadbalancer | No sample value for this parameter. | array format, return the list of load balancing instances. |
| LoadBalancer | No sample value for this parameter. | No description for this parameter. | |
| LoadBalancerId | string | lb-hjfng**** | load balancing instance ID. |
| PayType | string | PrePay | load balancing instance payment type, value:PayOnDemand or PrePay. |
| SlaveZoneId | string | cn-hangzhou-d | the standby zone ID of the instance. |
| InternetChargeType | string | paybybandwidth | the billing method of the public network instance. Value: paybybandwidth, billed by bandwidth. paybytraffic, charged by traffic (default). description when the value of the PayType parameter is PrePay, only bandwidth-by-bandwidth billing is supported. |
| RegionIdAlias | string | cn-qingdao-env17-d01 | the region name of the load balancing instance. |
| LoadBalancerName | string | def | the name of the load balancing instance. |
| VpcId | string | vpc-25dvzy9f8**** | the vpc ID of the private network load balancing instance. |
| NetworkType | string | vpc | the network type of the private network load balancing instance, value: vpc: vpc instance. classic: classic network instance. |
| RegionId | string | cn-qingdao-env17-d01 | the region ID of the load balancing instance. |
| AddressType | string | intranet | the network type of the load balancing instance. |
| LoadBalancerStatus | string | active | load balancing instance status: inactive: The instance listener in this state will no longer forward traffic. active: after the instance is created, the default state is active. locked: The instance has been locked. |
| MasterZoneId | string | cn-hangzhou-b | the main available area ID of the instance. |
| CreateTimeStamp | long | 1504147745000 | load balancing instance creation timestamp. |
Example
Successful Response example
{
"Address":"100.XX.XX.28",
"RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
"VSwitchId":"vsw-255ecr****",
"CreateTime":"2017-08-31T02:49:05Z",
"AddressIPVersion":"ipv4",
"LoadBalancers":"",
"LoadBalancer":"",
"LoadBalancerId":"lb-hjfng****",
"PayType":"PrePay",
"SlaveZoneId":"cn-hangzhou-d",
"InternetChargeType":"paybybandwidth",
"RegionIdAlias":"cn-qingdao-env17-d01",
"LoadBalancerName":"def",
"VpcId":"vpc-25dvzy9f8****",
"NetworkType":"vpc",
"RegionId":"cn-qingdao-env17-d01",
"AddressType":"intranet",
"LoadBalancerStatus":"active",
"MasterZoneId":"cn-hangzhou-b",
"CreateTimeStamp":"1504147745000"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}